/*
 * Copyright (c) 2012, Markus Weber All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer. Redistributions in binary form must reproduce the
 * above copyright notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
package de.dfki.graph.index;

import de.dfki.graph.LabeledGraph;

/**
 * Retrieval result from sub graph matching.
 *
 * @author Markus Weber
 *
 */
public class RetrievalResult implements Comparable<RetrievalResult> {

    private double retrievalScore = 0.0;
    private LabeledGraph floorplan;

    public RetrievalResult(double retrievalScore, LabeledGraph floorplan) {
        super();
        this.retrievalScore = retrievalScore;
        this.floorplan = floorplan;
    }

    /**
     * Returns the retrieval score.
     *
     * @return
     */
    public double getRetrievalScore() {
        return retrievalScore;
    }

    /**
     * Returns the floor plan.
     *
     * @return
     */
    public LabeledGraph getFloorplan() {
        return floorplan;
    }

    @Override
    public int compareTo(RetrievalResult o) {
        if (retrievalScore > o.retrievalScore) {
            return +1;
        }
        return -1;
    }
}
